/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.    
 */
package dk.redillusions.jdbc.proxy.statistics;

/**
 * Describes a class which is able to collect statistics within a period
 * specified by the {@link #start()} and {@link #stop()} operations.
 * 
 * @author Sune Wettersteen
 * 
 */
public interface IStatisticsReporter {
    /**
     * Start collecting statistics. Invoking this method while the service is
     * started has no effect.
     */
    void start();

    /**
     * Stop collecting statistics. Invoking this method while the service is
     * stopped has no effect.
     */
    void stop();

    /**
     * Check whether or not the report is currently running.
     * 
     * @return True if the reporter is running and collecting statistics,
     *         otherwise false
     */
    boolean isRunning();
}
